home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 090 / newdsz.arc / DSZ.DOC < prev   
Text File  |  1987-08-22  |  22KB  |  595 lines
  1.  
  2.  
  3.  
  4.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  5.  
  6.  
  7.  
  8.      NAME
  9.           dsz - ZMODEM, YMODEM, XMODEM file transfer subprogram
  10.  
  11.      SYNOPSIS
  12.           dsz [CON] [port N] [speed S] [handshake XX] [d] command
  13.  
  14.      DESCRIPTION
  15.           Dsz uses the ZMODEM, YMODEM, or XMODEM protocol to transfer
  16.           files over a serial port with a variety of programs.
  17.  
  18.           ZMODEM Transfers feature 32 bit CRC, crash recovery, and
  19.           advanced file management.
  20.  
  21.           True YMODEM(TM) transfers preserve exact file length and
  22.           modification time.
  23.  
  24.           Dsz supports XMODEM-1k (XMODEM with 1024 byte blocks,
  25.           sometimes mislabeled YMODEM) and CRC-16 with the sx -k and
  26.           rc commands.
  27.  
  28.           Dsz is derived from Omen Technology's Professional-YAM
  29.           communications software, (also published by POLYTRON Corp of
  30.           Hillsboro Oregon as PowerCom(TM)), and supports a subset of
  31.           Pro-YAM's file transfer related commands.  This
  32.           documentation makes extensive references to contemporary
  33.           editions of the ZCOMM or Pro-YAM manual, and is incomplete
  34.           without it.
  35.  
  36.           Dsz is designed to be called from a communications bulletin
  37.           board program.  Dsz may also be called from other
  38.           communications programs, but the combination lacks much of
  39.           the power of a communications program with integrated
  40.           ZMODEM.
  41.  
  42.           Dsz uses its own modem I/O.  The original interrupt vector,
  43.           UART parity, interrupt configuration, and 8259 interrupt
  44.           mask are restored on exit.
  45.  
  46.           Dsz uses DOS standard output (stdout) for messages, it does
  47.           not write directly to the screen.  Dsz expects its standard
  48.           output to point to the console, a logging file, or NUL, not
  49.           the modem port.  If necessary, dsz's standard output may be
  50.           redirected to the console device with the CON command.  If
  51.           dsz's standard output has been redirected to the modem (as
  52.           with ProComm's Host mode DOS shell), failure to use the CON
  53.           command may lock up the computer.
  54.  
  55.           Dsz exits with 0 status for successful transfers, or the
  56.           value of the Q parameter (default 1) if a file transfer
  57.           failed.  Some languages do not return this information to
  58.           the calling program.  A batch file that calls dsz directly
  59.           may be used to detect the dsz exit status, or dsz's log file
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 8/22/87)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  71.  
  72.  
  73.  
  74.           entries may be examined.
  75.  
  76.      ENVIRONMENT VARIABLES
  77.           DSZLOG
  78.                log file to receive entries for files sent and
  79.                received.  (Default null).  Sample entries:
  80.  
  81.            Z  46532 38400 bps 3324 cps   0 errors    66 1024 DSZ.COM
  82.            Z 124087 19200 bps 1880 cps   0 errors     6 1024 MXY.TMP
  83.  
  84.                Transfer times are based on the DOS time of day clock
  85.                and have one second jitter.  As with all protocol
  86.                throughput reports generated by Omen Technology
  87.                programs (and contrary to the false claims of some
  88.                critics), dsz's throughput figures for ZMODEM, Kermit,
  89.                and True YMODEM(TM) transfers do not take "credit" for
  90.                pathname or protocol overhead characters.  Dsz's
  91.                throughput reports do not include the time required to
  92.                send the pathname.  This understates the true time
  93.                required to transfer files, but the time required to
  94.                send the pathname often depends on the alacrity of the
  95.                operator, and thus does not always reflect the
  96.                performance of the protocol itself.
  97.  
  98.                Transfers measuring less than one second are reported
  99.                as having 9999 characters per second throughput.
  100.  
  101.                The unlabeled numeric field after the error (retry)
  102.                count is the number of flow control stoppages
  103.                encountered sending the file.  This number gives an
  104.                indication of flow control restrictions (overloaded
  105.                networks, etc.).
  106.  
  107.                The last numeric field is the block or subpacket length
  108.                used for the last block in the file.
  109.  
  110.                The code letter indicates the type of transfer, Z
  111.                (ZMODEM), S (X/YMODEM), R (X/YMODEM), E (error), or L
  112.                (transfer terminated by loss of data carrier).
  113.           DIRSIZE
  114.                Memory to allocate for wildcard file name expansion,
  115.                default 1495 bytes.
  116.           DSZPORT
  117.                Default communications port override, default 1.
  118.  
  119.      COMMANDS
  120.           Dsz commands are an improper subset of Pro-
  121.           YAM/PowerCom/ZCOMM commands.  Except as noted, all commands
  122.           must be in lower case.
  123.  
  124.           Unlike ZCOMM, PowerCom, and Pro-YAM, dsz does not support
  125.           ZMODEM AutoDownload and ZMODEM command download with ZMODEM
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 8/22/87)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  137.  
  138.  
  139.  
  140.           security challenge.  (AutoDownload is a pleasant user
  141.           interface that recognizes the start of a file download and
  142.           automatically starts the correct file transfer protocol.
  143.           Please refer to the ZCOMM/PowerCom/Pro-YAM user manual for
  144.           details on this powerful and convenient feature.) Dsz does
  145.           not support OverThruster(TM), Kermit, Kermit AutoDownload,
  146.           Super Kermit, B Protocol, the traditional XMODEM variants
  147.           MODEM7, Telink, WXMODEM, and Clink/SEAlink supported by
  148.           Pro-YAM/PowerCom/ZCOMM.
  149.  
  150.           Interrupt keys:
  151.  
  152.           Ctrl-Break
  153.                Terminates the transfer in progress.
  154.           ALT-N
  155.                Abruptly terminates (NUKES) the transfer in progress.
  156.  
  157.  
  158.           When used, the CON, port, speed, handshake, and d commands
  159.           must be given in the order shown.
  160.  
  161.           CON  Redirect message output to the DOS "CON" (console)
  162.                device, overriding any previous redirections.
  163.           handshake XX
  164.                Enable one of several choices of hardware handshake.
  165.                (The default is XOFF/XON software handshake).  This
  166.                command is documented in the ZCOMM or Pro-YAM manual.
  167.           port N
  168.                select port N (n = 1,2,3,4 ... 8) Default is port 1
  169.                (COM1) or read from the DSZPORT dos environment
  170.                variable.
  171.           speed S
  172.                Set the specified speed.  This command is rarely needed
  173.                because dsk reads the port's current speed by default.
  174.                Please refer to to the FLOW CONTROL, MAIN COMMANDS and
  175.                SOFTWARE COEXISTENCE chapters in the ZCOMM or Pro-YAM
  176.                manual for important information about the speed
  177.                command.
  178.           d    Disables carrier dropout monitoring, for modems that do
  179.                not properly drive the "Data Carrier Detect" input on
  180.                the PC.
  181.           LARG Convert ARG to lower case, then parse arg.
  182.           pxN  Set a numeric parameter x to N.  These parameters are a
  183.                subset of the Pro-YAM or ZCOMM numeric parameters, and
  184.                are listed below.  They assume their defaults each time
  185.                dsz is called.  Without an argument, p displays the
  186.                numeric parameters and their values.
  187.           z pxN
  188.                Set zmodem numeric parameter x to N.  These parameters
  189.                correspond to the Pro-YAM or ZCOMM "zmodem" parameters
  190.                and rarely need changing.  These parameters assume
  191.                their defaults each time dsz is called.  Without an
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 8/22/87)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  203.  
  204.  
  205.  
  206.                argument, z p displays the zmodem numeric parameters
  207.                and their values.
  208.           restrict
  209.                Restrict pathnames to the current disk and directory
  210.                tree, and disallows overwriting of existing files.
  211.           t    Talk with ZMODEM AutoDownload.  A small subset of Pro-
  212.                YAM term function subcommands are recognized.  Keyboard
  213.                F1 or ALT-X to exit.  F3 receives file(s) with True
  214.                YMODEMTm, ALT-P toggles parity between the 8N default
  215.                and 8G (enables ANSI "graphics").  ALT-H toggles two
  216.                local echo ("Half Duplex") modes; the second displays a
  217.                newline on Enter.  Keyboarded ASCII characters are sent
  218.                to the modem.  Modem characters print on the screen.  A
  219.                device driver such as ANSI.SYS may be used to recognize
  220.                escape sequences.  ZMODEM AutoDownload detects the
  221.                start of a ZMODEM file download and accepts the file(s)
  222.                without operator intervention.
  223.           sz   [-abenprY+y] [PREFIX=p | ONAME=n] file ...(ZMODEM)
  224.           sb   [-k] [PREFIX=p | ONAME=n] file ...      (YMODEM or
  225.                ZMODEM)
  226.           sx   [-k] file1                    (XMODEM or XMODEM/CRC)
  227.           rz   [-abenpr+Yy] [dir] [file ...] (ZMODEM)
  228.           rb   [-ab+y] [dir] [file ...]      (YMODEM)
  229.           rb -g
  230.                [-ab+y] [dir] [file ...]      (YMODEM-G)
  231.           rc   [-ab+y] file1                 (XMODEM/CRC)
  232.           rx   [-ab+y] file1                 (XMODEM)
  233.  
  234.      PARAMETERS
  235.           Dsz uses the following main numeric parameters, settable
  236.           with the pxN command.  In addition, dsz uses the Pro-
  237.           YAM/ZCOMM zmodem numeric parameters described in the Pro-
  238.           YAM/ZCOMM manual.
  239.  
  240.           B    Set the size of buffer used for disk reads and writes.
  241.                The default is 1024, 8192 maximum.  A larger value may
  242.                give better results when sending files to or from from
  243.                sluggish floppy disk systems.  Too large a value will
  244.                exhaust memory or induce receiver timeouts.  This
  245.                parameter is supported on versions compiled with
  246.                TurboC.
  247.           Q    Error code returned to DOS (default 1).  (Success
  248.                returns 0.) Some programs toss cookies with when
  249.                confronted with certain exit codes.
  250.           S    Timeout in seconds waiting for restraint release (XON
  251.                and/or handshake).
  252.           W    Wait for Enter key before exiting after an error.
  253.                Useful when calling dsz from DESQview, allows the
  254.                window to close unless there is an error message that
  255.                should remain visible.
  256.           a    Calibrates certain protocol timeouts used with XMODEM
  257.                and YMODEM transfers (Cybernetic Data Recovery(TM)).
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 8/22/87)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  269.  
  270.  
  271.  
  272.                The a numeric parameter is automatically set to 2000
  273.                for a 4.77 mHz PC or XT, 4000 for a PS2/30, 6000 for an
  274.                8 mHz 1ws AT, and 12000 for a PS2/80.  If your computer
  275.                has a speedup card or otherwise runs unusually fast (or
  276.                slow!) for its type, you should set the a numeric
  277.                parameter to a value that reflects its speed.
  278.           v    Verbose level (debugging output) Negative values
  279.                inhibit some routine messages
  280.           z    Timezone in minutes behind GMT
  281.  
  282.      BACKGROUND OPERATION
  283.           Three DESQview description files are provided to demonstrate
  284.           background operation with modest (66 kb window) memory
  285.           requirements.  Dsz uses tight C/ASM code, table driven CRC
  286.           generators, and buffered receive and transmit for good
  287.           performance in the background without hogging CPU cycles.
  288.           On a QIC Labs PC-AT clone, dsz can download files in the
  289.           background (3 background clock ticks, 9 foreground clock
  290.           ticks) with a throughput better than 9600 bps.
  291.  
  292.           2S   Prompts for file name(s) and sends them with ZMODEM
  293.                protocol.
  294.           2T   Talks to the modem and allows manual YMODEM (F3) or
  295.                automatic ZMODEM downloads.
  296.           2A   Like 2T, but using Quarterdeck's dvansi.com memory
  297.                resident ANSI CRT device driver to process ANSI screen
  298.                codes.  DS.BAT is the batch file used by 2A.
  299.  
  300.                These files are written for port 2 local connection,
  301.                but may be modified to suit your requirements.
  302.  
  303.                Operation at high speed (above 9600 bps) requires the
  304.                DESQview "Optimize communications" performance Advanced
  305.                Setup option.
  306.  
  307.      FLOW CONTROL
  308.           Please refer to the Pro-YAM, PowerCom, or ZCOMM manual FLOW
  309.           CONTROL chapter for important information on flow control
  310.           considerations necessary for proper operation of ZMODEM and
  311.           other streaming protocols with buffered (error correcting)
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 8/22/87)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  335.  
  336.  
  337.  
  338.           modems and/or networks.
  339.  
  340.      EXAMPLES
  341.           dsz sz c:foo.* b:*.c          (send files)
  342.  
  343.           dsz sz -r zmodem.arc          (CRASH RECOVERY: resume
  344.           interrupted transfer)
  345.  
  346.           dsz handshake both sz zmodem.arc        (Hardware+Software
  347.           handshake)
  348.  
  349.           dsz sz -n *.*                 (send files that are newer or
  350.           rx has no copy)
  351.  
  352.           dsz sz -Yn *.*                (Only send files that are
  353.           newer than receiver's copy)
  354.                                                   (Do not send files
  355.           that do not exist on receiver's disk)
  356.  
  357.           dsz rz C:/UPLOADS             (receive files to specified
  358.           directory)
  359.  
  360.           dsz port 2 speed 38400 restrict rz
  361.  
  362.           dsz rz  -y prog.arc           (ZMODEM, single file pathname
  363.           override)
  364.  
  365.           dsz z pr1 rx foo.dat          (XMODEM receive, remove file
  366.           if error)
  367.  
  368.           DSZ LRC L-Y NEWPROG.ARC       (generate lower case "rc -y"
  369.           command)
  370.  
  371.           dsz pv2 sz foo >debug.dmp     (Debugging data dump)
  372.  
  373.      ERROR MESSAGES
  374.           Dsz's error messages are a subset of Pro-YAM's error
  375.           messages which are listed in the Pro-YAM manual.  A
  376.           perplexing, cryptic message comes from the Microsoft C
  377.           Library: "Permission denied".  This may be caused by
  378.           attempts to modify a read only file or directory.
  379.  
  380.      SEE ALSO
  381.           Consult the Professional-YAM, PowerCom, or ZCOMM manual
  382.           chapter "OPTIONS FOR FILE TRANSFERS" for option meanings.
  383.           The "FILE TRANSFER BASICS" chapter explains the relative
  384.           merits of XMODEM, YMODEM, ZMODEM, and other protocols and
  385.           gives tips on their use.  The "MAIN COMMANDS" chapter
  386.           describes the rb, rx, rc, rz, sb, and sz commands.  The
  387.           "MODEM INTERFACING" and "FLOW CONTROL" chapters contain
  388.           important information on the use of buffered modems with
  389.           dsz.
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 8/22/87)
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  401.  
  402.  
  403.  
  404.           Information on the ZMODEM Inter Application File Transfer
  405.           Protocol may be found in ZMODEM.DOC, part of ZMODEM.ZOO.
  406.  
  407.           C Source code for XMODEM, YMODEM, and ZMODEM transfers is
  408.           included in RZSZ.ZOO.  This file includes a Pro-YAM/ZCOMM
  409.           script to upload a bootstrap file to a Unix system, force
  410.           its compilation, and (if the compilation is successful)
  411.           upload the rz/sz source files.
  412.  
  413.      NOTES
  414.           Some XMODEM programs claiming to support YMODEM do not send
  415.           or accept the YMODEM pathname block.  1024 byte XMODEM is
  416.           XMODEM-1k, not YMODEM.  1987 versions of YMODEM.DOC clarify
  417.           the official YMODEM definition.
  418.  
  419.           When running under ProComm's Host mode, failure to use the
  420.           CON command may lock up the computer.  ProComm must be set
  421.           to "8N1" to prevent it from disrupting DSZ.
  422.  
  423.           When installing dsz on a bulletin board or host system, be
  424.           sure to check for proper operation when the caller hangs up
  425.           while a file is being sent or recieved.
  426.  
  427.           32 bit CRC code courtesy Gary S. Brown.
  428.  
  429.           Cybernetic Data Recovery(TM), Error Containment(TM),
  430.           OverThruster(TM), Password Guardian(TM), CryptoScript(TM),
  431.           and TurboDial(TM) are Omen Technology trademarks.
  432.  
  433.           PowerCom was trademarked in 1985 by POLYTRON Corporation,
  434.           Hillsboro Oregon.
  435.  
  436.           Dsz and this documentation are Copyright 1987 by Omen
  437.           Technology Inc, all rights reserved.  True YMODEM(TM) is an
  438.           Omen Technology Trademark signifying YMODEM protocol support
  439.           that meets the full YMODEM specification.
  440.  
  441.      FILES
  442.           ZCOMMDOC.ARC, ZCOMMEXE.ARC, ZCOMMHLP.ARC, ZMODEM.ZOO
  443.           (zmodem.arc), RZSZ.ZOO (rzsz.arc) (Unix/Xenix source code),
  444.           2S-PIF.DVP, 2A-PIF.DVP, DS.BAT, 2T-PIF.DVP DSZ.COM, DSZ.DOC
  445.           (this file).
  446.  
  447.           DSZ.EXE compiled with the Xenix to DOS XC provides
  448.           moderately higher maximum throughput (1700 vs 1300 cps
  449.           downloading to a 4.77 mHz XT).  The speed difference is a
  450.           function of the compiler, the source code is the same.  The
  451.           Xenix XC version requires more memory, and does not support
  452.           file sharing or a large I/O buffer.  This version is
  453.           available in DSZEXE.ZOO.
  454.  
  455.           ZCOMM and Pro-YAM also run at a higher speed than DSZ.
  456.  
  457.  
  458.  
  459.      Page 7                                          (printed 8/22/87)
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  467.  
  468.  
  469.  
  470.           Incompatible batch files may cause dsz to fail.
  471.  
  472.      LICENSE
  473.           Dsz is a user supported program written by Chuck Forsberg.
  474.           This documentation file must be provided with all copies of
  475.           DSZ except by written permission from Omen Technology Inc.
  476.           Dsz may not be modified or sold without prior written
  477.           permission by Omen Technology Inc.  Distribution of dsz in
  478.           an archive without this documentation file constitutes an
  479.           unauthorized modification.
  480.  
  481.           When dsz is distributed on disk, a contemporary copy of
  482.           ZCOMMDOC.ARC must be included on the same disk.
  483.  
  484.           Dsz may be freely used and copied by bulletin board systems
  485.           which feature the ZCOMM files (ZCOMMEXE.ARC, ZCOMMDOC.ARC,
  486.           ZCOMMHLP.ARC) for downloading.  Dsz may be registered
  487.           without charge by sending your bulletin board's telephone
  488.           number and a valid login to
  489.  
  490.                  Omen Technology Inc.
  491.                  P.O. Box 4681
  492.                  Portland, OR 97231.
  493.  
  494.           Dsz registration and a diskette with current versions of the
  495.           ZCOMM files will be mailed upon validation.
  496.  
  497.           Other users may register their copy of dsz with a check for
  498.           $20.00 sent to the same address.
  499.  
  500.           The registration package includes a serial number and
  501.           installation program which bypasses the solicitation
  502.           display.
  503.  
  504.           The putsnp program inserts YOUR DSZ, ZCOMM, PowerCom, or
  505.           Pro-YAM Serial Number Password (SNP) into you copy of DSZ:
  506.                  putsnp dsz.com
  507.           Putsnp accepts your SNP and asks appropriate questions
  508.           before inserting the SNP.
  509.  
  510.      CHANGES
  511.           Protocol transfer timing has been modified to depend less on
  512.           the "a" numeric parameter.  The procedure described in some
  513.           editions of the Pro-YAM manual for adjusting the "a" numeric
  514.           parameter does not apply to current software versions.
  515.  
  516.           Versions after March 1987 buffer both transmitted and
  517.           received data, providing enhanced throughput with multi
  518.           tasking systems such as DESQview.
  519.  
  520.           Versions compiled with TurboC support the B numeric
  521.           parameter and code to allow file sharing on transmitted
  522.  
  523.  
  524.  
  525.      Page 8                                          (printed 8/22/87)
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.      DSZ(DOS)                 Omen Technology                 DSZ(DOS)
  533.  
  534.  
  535.  
  536.           files.
  537.  
  538.           The t (Talk) command and W parameter have been added to make
  539.           background operation with DESQview more pleasant.
  540.  
  541.           The 7-20-87 version corrects a bug in the ZMODEM protocol
  542.           that could allow a CRC error near the end of file to induce
  543.           a protocol breakdown.  All previous versions of DSZ should
  544.           be replaced.
  545.  
  546.           The 7-22-87 version uses the TurboC Tiny model to allow the
  547.           program to run in less memory.
  548.  
  549.           The 8-02-87 version adds the "Q" numeric parameter for the
  550.           benefit of certain programs that choke when a subprogram
  551.           exits with a 1 code.  Turbo C versions now use the "B"
  552.           numeric parameter for binary downloads.  The UART parity
  553.           setting is restored on exit.
  554.  
  555.           The "Y" option and three log file fields were added to the
  556.           8-09-87 version.
  557.  
  558.           Recovery from line hits concident with skipping files and
  559.           XMODEM-CRC fallback to checksum were fixed in the 8-21-87
  560.           version.  The sz command fallback to YMODEM has been
  561.           eliminated to improve reliability.
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.      Page 9                                          (printed 8/22/87)
  592.  
  593.  
  594.  
  595.